Inscoper::SubDeviceConfig¶

SubDeviceConfig class provides required information for sub-device configuration. More...

#include <SubDeviceConfig.h>

Public Functions¶

	Name
	SubDeviceConfig() Default constructor.
void	fromXML(Inscoper::XMLNode & subDeviceNode) Provide sub-device information from the XML node.
void	toXML(Inscoper::XMLNode & xmlParent) Export sub-device information in an XML node attached to the parent XML node.
const std::string &	getId() const Get the ID of the sub-device.
void	setId(const std::string & id) Set the ID of the sub-device.
unsigned short	getTag() const Get the sub-device tag.
void	setTag(unsigned short tag) Set the sub-device tag.
bool	isPostInit() const Check if post-initialization is required.
void	setPostInit(bool postInit) Set post-initialization status.
const std::string &	getRecipeId() const Get the recipe ID of the sub-device.
void	setRecipeId(const std::string & recipeId) Set the recipe ID of the sub-device.
const std::vector< Inscoper::ParamConfigPtr > &	getParams() const Get the parameter configuration list of the sub-device.
Inscoper::ParamConfigPtr	getParam(unsigned short tag) const Get the parameter configuration corresponding to the given tag.
void	setParams(const std::vector< Inscoper::ParamConfigPtr > & params) Set the parameter configuration list of the sub-device.
void	addParam(const Inscoper::ParamConfigPtr & param) Add a parameter configuration to the list.

Detailed Description¶

class Inscoper::SubDeviceConfig;

SubDeviceConfig class provides required information for sub-device configuration.

This class manages the configuration settings for a sub-device, including its ID, tag, associated parameters, and initialization status.

Public Functions Documentation¶

function SubDeviceConfig¶

SubDeviceConfig()

Default constructor.

Initializes a new instance of the SubDeviceConfig class.

function fromXML¶

void fromXML(
    Inscoper::XMLNode & subDeviceNode
)

Provide sub-device information from the XML node.

Parameters:

subDeviceNode : The XML node containing sub-device information

Exceptions:

InscoperException if an error occurred

Populates the sub-device configuration from the provided XML node.

function toXML¶

void toXML(
    Inscoper::XMLNode & xmlParent
)

Export sub-device information in an XML node attached to the parent XML node.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException if an error occurred

Serializes the sub-device configuration to the specified parent XML node.

function getId¶

const std::string & getId() const

Get the ID of the sub-device.

Return: The ID of the sub-device

Retrieves the unique identifier of the sub-device.

function setId¶

void setId(
    const std::string & id
)

Set the ID of the sub-device.

Parameters:

id : The ID of the sub-device

Assigns a unique identifier to the sub-device.

function getTag¶

unsigned short getTag() const

Get the sub-device tag.

Return: The sub-device tag

Retrieves the tag associated with this sub-device.

function setTag¶

void setTag(
    unsigned short tag
)

Set the sub-device tag.

Parameters:

tag : The sub-device tag

Assigns a tag to this sub-device.

function isPostInit¶

bool isPostInit() const

Check if post-initialization is required.

Return: True if post-initialization is required, false otherwise

Determines whether this sub-device requires a post-initialization step.

function setPostInit¶

void setPostInit(
    bool postInit
)

Set post-initialization status.

Parameters:

postInit : True to enable post-initialization

Specifies whether this sub-device requires a post-initialization step.

function getRecipeId¶

const std::string & getRecipeId() const

Get the recipe ID of the sub-device.

Return: The recipe ID of the sub-device

Retrieves the recipe ID associated with this sub-device.

function setRecipeId¶

void setRecipeId(
    const std::string & recipeId
)

Set the recipe ID of the sub-device.

Parameters:

recipeId : The recipe ID of the sub-device

Assigns a recipe ID to this sub-device.

function getParams¶

const std::vector< Inscoper::ParamConfigPtr > & getParams() const

Get the parameter configuration list of the sub-device.

Return: The list of parameter configurations of the sub-device

Retrieves the list of parameter configurations associated with this sub-device.

function getParam¶

Inscoper::ParamConfigPtr getParam(
    unsigned short tag
) const

Get the parameter configuration corresponding to the given tag.

Parameters:

tag : The parameter tag

Return: The parameter configuration

Retrieves the parameter configuration for the specified tag.

function setParams¶

void setParams(
    const std::vector< Inscoper::ParamConfigPtr > & params
)

Set the parameter configuration list of the sub-device.

Parameters:

params : The list of parameter configurations of the sub-device

Replaces the list of parameter configurations for this sub-device.

function addParam¶

void addParam(
    const Inscoper::ParamConfigPtr & param
)

Add a parameter configuration to the list.

Parameters:

param : The parameter configuration to add

Appends a new parameter configuration to the sub-device.

Updated on 2026-04-02 at 10:55:36 +0200